Skip to content

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented May 28, 2025

This PR improves the quickstart documentation to make it more translatable by following best practices for technical writing:

  • Reduced wordiness and simplified complex sentences
  • Converted passive voice to active voice
  • Replaced negative instructions with positive directives
  • Eliminated ambiguous pronouns by using specific nouns
  • Used descriptive link text instead of ambiguous link anchors
  • Replaced nominalizations with active verbs
  • Simplified stacked modifiers and complex noun phrases
  • Shortened and simplified prepositional phrases
  • Replaced modal verbs with direct commands
  • Used straightforward statements instead of conditional language
  • Clarified singular vs plural references
  • Defined acronyms on first use
  • Removed slang and culturally specific examples

These changes maintain all original information and structure while making the content clearer and more translatable across languages.

Copy link
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 + 🤓 = ✨ 📄 ✨

@ethanpalm ethanpalm merged commit ca91910 into main May 30, 2025
5 checks passed
@ethanpalm ethanpalm deleted the docs-update-1748454843-377049 branch May 30, 2025 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant